10.2 Consultar séries

Request

Request

query AcademicSeries {
    academicSeries(take: 1) {
        items {
            serie
            academicLevelId
            id
            refId
            externalId
            creationDate
            active
            deleted
            lastUpdateDate
        }
        totalCount
        pageInfo {
            hasNextPage
            hasPreviousPage
        }
    }
}

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem pulados no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	AcademicSerieFilterInput	Objeto que define os critérios de filtragem para as séries.
order	[AcademicSerieSortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto AcademicSerieFilterInput

Campo	Tipo	Descrição
academicClasses	ListFilterInputTypeOfAcademicClassFilterInput	Filtro para as turmas associadas à série
academicLevel	AcademicLevelFilterInput	Filtro para o nível acadêmico da série
academicLevelId	IntOperationFilterInput	Filtro para o ID do nível acadêmico da série
active	BooleanOperationFilterInput	Filtro para o status de ativação da série
and	[AcademicSerieFilterInput!]	Combina filtros usando a lógica AND
changes	ListFilterInputTypeOfLogHistoryFilterInput	Filtro para o histórico de alterações da série
creationDate	DateTimeOperationFilterInput	Filtro para a data de criação da série
deleted	BooleanOperationFilterInput	Filtro para o status de deleção da série
externalId	IntOperationFilterInput	Filtro para o ID externo da série
id	IntOperationFilterInput	Filtro para o ID do objeto da requisição da série
lastUpdateDate	DateTimeOperationFilterInput	Filtro para a data da última atualização da série
or	[AcademicSerieFilterInput!]	Combina filtros usando a lógica OR
refId	UuidOperationFilterInput	Filtro para o ID de referência da série
serie	StringOperationFilterInput	Filtro para o nome da série

Objeto AcademicSerieSortInput

Campo	Tipo	Descrição
academicLevel	AcademicLevelSortInput	Critério de ordenação para o nível acadêmico associado à série
academicLevelId	SortEnumType	Critério de ordenação para o ID do nível acadêmico
active	SortEnumType	Critério de ordenação para o status de ativação da série
creationDate	SortEnumType	Critério de ordenação para a data de criação da série
deleted	SortEnumType	Critério de ordenação para o status de deleção da série
externalId	SortEnumType	Critério de ordenação para o ID externo da série
id	SortEnumType	Critério de ordenação para o ID do objeto da requisição da série
lastUpdateDate	SortEnumType	Critério de ordenação para a data da última atualização da série
refId	SortEnumType	Critério de ordenação para o ID de referência da série
serie	SortEnumType	Critério de ordenação para o nome da série

Response

Response

{
    "data": {
        "academicSeries": {
            "items": [
                {
                    "serie": "1º Série",
                    "academicLevelId": 1,
                    "id": 1,
                    "refId": "72e406aa-6e24-49b2-b7d5-a8958caeb79a",
                    "externalId": null,
                    "creationDate": "2024-05-20T17:38:18.475Z",
                    "active": true,
                    "deleted": false,
                    "lastUpdateDate": null
                }
            ],
            "totalCount": 18,
            "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": false
            }
        }
    }
}

Result

Campo	Tipo	Descrição
academicSeries	AcademicSeriesCollectionSegment	Coleção de séries

Objeto AcademicSeriesCollectionSegment

Campo	Tipo	Descrição
items	[AcademicSerie!]	Lista de objetos do tipo AcademicSerie
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.